Enhance README, refactor package, and improve testing setup#1
Merged
francescobianco merged 13 commits intomainfrom Mar 18, 2026
Merged
Enhance README, refactor package, and improve testing setup#1francescobianco merged 13 commits intomainfrom
francescobianco merged 13 commits intomainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant improvements to the project, focusing on developer experience, documentation, and project infrastructure. It adds robust documentation (including usage, contributing, and code of conduct guides), enhances automation with a Makefile and GitHub Actions workflow, and provides example scripts for token generation and API calls. The project metadata has been updated for clarity and correctness, and a conventional commit configuration has been introduced to standardize commit messages.
Documentation and Examples
README.mdto provide a comprehensive overview, installation steps, usage examples, features, partner acknowledgments, and licensing details. Also adds badges and partner information. [1] [2]docs/contributing.mdanddocs/code-of-conduct.mdto clarify contribution guidelines and establish a code of conduct. [1] [2]docs/readme-pypi.mdfor PyPI-specific documentation.examples/token_generation.pyandexamples/api_calls.pyto demonstrate authentication and API usage. [1] [2]Project Automation and Tooling
Makefilewith commands for development, building, publishing, and releasing the package, as well as Poetry setup..github/workflows/python.yml) for CI/CD, testing across multiple Python versions, and building the package.Project Configuration and Metadata
pyproject.toml:openapi-python-sdkand version to0.2.0Developer Experience
.convcommitfile to standardize commit messages using the Conventional Commit format, with detailed instructions and options for the team.